/*
 * Copyright 2011 Clean GWT
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
package com.cleangwt.uibinder.client;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import com.cleangwt.json.client.SimpleObject;

/**
 * The {@literal @}{@link UiInput}'s addon tag for push extra value to the
 * {@link RequiresFormRebind#getFormData(SimpleObject)}.
 * 
 * <pre>
 * For example below :
 * 
 * {@literal @}UiInputAddon(name="optionText", value="text")
 * ListBox option;
 * 
 * the part of generated codes would be :
 * 
 * public void getFormData(SimpleObject value){
 * 	// default generated
 * 	value.put("option",client.option.getValue());
 * 	// addon generated
 * 	value.put("optionText",client.option.getText());
 * }
 * 
 * </pre>
 * 
 * @author Jess
 * @version 1.0
 * @since 1.0
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(value = ElementType.FIELD)
public @interface UiInputAddon {
  /**
   * @return the name of form data
   */
  String[] name();

  /**
   * @return the value name of field
   */
  String[] value();
}
